class: left, top, my-title, title-slide # Building a Sustainable R Ecosystem for Reporting ### Lindsey Dietz, PhD ### noRth 2021 Tutorial (September 29, 2021) <br> <svg viewBox="0 0 496 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg><a href="https://github.com/rnorthconference/2021Talks/">noRth 2021 Github</a> <br> <svg viewBox="0 0 448 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M400 32H48C21.49 32 0 53.49 0 80v352c0 26.51 21.49 48 48 48h352c26.51 0 48-21.49 48-48V80c0-26.51-21.49-48-48-48zM178.117 262.104C87.429 196.287 88.353 196.121 64 177.167V152c0-13.255 10.745-24 24-24h272c13.255 0 24 10.745 24 24v25.167c-24.371 18.969-23.434 19.124-114.117 84.938-10.5 7.655-31.392 26.12-45.883 25.894-14.503.218-35.367-18.227-45.883-25.895zM384 217.775V360c0 13.255-10.745 24-24 24H88c-13.255 0-24-10.745-24-24V217.775c13.958 10.794 33.329 25.236 95.303 70.214 14.162 10.341 37.975 32.145 64.694 32.01 26.887.134 51.037-22.041 64.72-32.025 61.958-44.965 81.325-59.406 95.283-70.199z"></path></svg><a href="mailto:lindseydietz13@gmail.com">lindseydietz13@gmail.com</a> <br> <svg viewBox="0 0 448 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"></path></svg><a href="https://www.linkedin.com/in/lindseydietz/">lindseydietz</a> <br> <svg viewBox="0 0 512 512" style="height:1em;position:relative;display:inline-block;top:.1em;" xmlns="http://www.w3.org/2000/svg"> <path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path></svg> <a href="https://twitter.com/lindseydietz13">lindseydietz13</a> --- # Disclaimer The views expressed in this presentation are strictly my own. They do not necessarily represent the position of the Federal Reserve Bank of Minneapolis or the Federal Reserve System. --- # Who am I? .pull-left[  ] .pull-right[ - Financial Economist working on stress testing models - Co-creator of the noRth conference - [R Ladies - Twin Cities meetup co-organizer](https://www.meetup.com/rladies-tc/members/) - [IF/THEN AAAS STEM Ambassador](https://www.ifthenshecan.org/ambassadors/) - [Hall of Fame college athlete](https://umdbulldogs.com/honors/umd-athletic-hall-of-fame/lindsey-dietz/130) ] --- # Goal of this tutorial Introduce R tools that help you communicate a data story in a professional, sustainable, and beautiful way.  --- # In this tutorial - How to set up your R ecosystem to support report creation in HTML (and PDF) -- - Examples of table and graphics packages to support analysis -- - Tips and tricks to make your reports dazzling and reproducible --- # Not in this tutorial >- Setting up version control - please use it! Check out Jenny Bryan's [Happy Git and Github with R](https://happygitwithr.com/) >- Details of the tables or graphics packages - these could easily be their own tutorials >- Shiny - we are going to focus on HTML (primary) and PDF (secondary) reports The good news is several speakers tomorrow will cover Shiny and other graphics applications! --- # Older process of reporting - Do analysis in one tool (R/SAS/SPSS/etc.) -- - Make tables and charts in another tool (Excel) -- - Paste everything into a text editor (Word/LaTeX) -- - Turn it into a final product (PDF) -- .center[  ] --- # Build an R ecosystem for Reporting  --- # Create workflows that shred  --- # R Project "R experts keep all the files associated with a project together — input data, R scripts, analytical results, figures. This is such a wise and common practice that RStudio has built-in support for this via projects." -- Hadley Wickham ([R for Data Science](https://r4ds.had.co.nz/workflow-projects.html)) -- R projects define your working directories: - Paths are relative rather than fixed - Your work is portable and tidy --- # Let's do it! 1. Open RStudio 2. Configure global options to avoid saving .Rdata - Tools -> Global Options -> Workspace -> Uncheck the box. Change the dropdown to Never. - Restart RStudio 3. Create an R project to associate with this talk or another set of files --- # Embrace the magic of R Markdown .center[] --- # What is R Markdown? R code + Markdown (text-to-HTML conversion tool) = R Markdown -- R Markdown files are designed to be used in three ways: -- - As an environment for you to do data science. -- - Collaborating with other data scientists with interest in your conclusions and how you reached them (the code). -- - **For communicating to decision makers, who want to focus on the conclusions, not the code behind the analysis.** --- # Let's do it! 1. Open the 0_dazzle.Rmd file inside the report folder - YAML Header - Code chunks - Markdown/LaTeX 2. Open the 1_dazzle.Rmd file inside the report folder - File organization 3. Open the 2_dazzle.Rmd file inside the report folder - Knitting with parameters 4. Open the 3_dazzle.Rmd file inside the report folder - Adding HTML and tables --- # Dazzling Elements in R Markdown - Using parameters in YAML header - Hiding code chunks and including 'Easter eggs' for other analysts - Using tabs and drop downs to improve pagination - Adding meaningful color to output - [Style output using HTML themes](https://www.datadreaming.org/post/r-markdown-theme-gallery/) --- # Folder Infrastructure .pull-left[ - Store long R scripts separate from your R Markdown files - Consider preprocessing and storage of summary data - Don't try to fit too much into one report; separate reports into their own folder ] .pull-right[  ] --- # Why HTML .pull-left[  ] -- .pull-right[ - HTML is *interactive* without being Shiny - HTML is *portable* and everyone you know has a web browser - TeX overhead can be high for creation of pdf and RMD files may fail to knit in different environments ] --- # If you must PDF - As long as you are not using LaTeX outside of R, you can use a minimal install of TeX via the `tinytex` package ```r install.packages('tinytex') tinytex::install_tinytex() ``` - [TinyTeX is a custom LaTeX distribution based on TeX Live that is small in size](https://yihui.org/tinytex/) - YMMV: errors can accumulate especially if you don't have admin rights on your computer --- # Step 3. Build your tabular content There are many table packages. For HTML, `DT` and `reactable` are good starting points. For pdf, `kableExtra` is the gold standard. .center[] --- # Step 4. Build your graphical content `ggplot2` works great as a static graphics package. For interactive graphics, use packages like `plotly` or `highcharter`. .center[] --- # Tips for Tables and Graphics - Create tables and graphics to support a narrative + Storyboard your ideas on paper or a whiteboard before diving in - Build the tables and graphics outside of R Markdown first to avoid extra loading overhead - Think about your user's needs + Do they like to download the data? + Are you using color in an intentional way? (1 in 12 men are colorblind) --- # Additional UX principles for reporting Your report should: - Have a clear hierarchy that makes navigation natural - Understand and embrace accessibility - Maintain time consistency - transition to or away from ideas slowly --- # Extensions - Version control of your reports - Deployment on a centralized server such as RStudio Connect opens up options such as scheduled reporting with email blasts - HTML reporting could be extended to true Shiny reporting if your users are asking for more interactivity --- # References and Credits - Artwork by Allison Horst sourced from [Github](https://github.com/allisonhorst/stats-illustrations) - [R for Data Science](https://r4ds.had.co.nz/workflow-projects.html) - [Advanced R](https://adv-r.hadley.nz/) - [Happy Git and Github with R](https://happygitwithr.com/) - [R Markdown Driven Development by Emily Riederer at rstudio::conf 2020](https://www.rstudio.com/resources/rstudioconf-2020/rmarkdown-driven-development/) <style type="text/css"> .remark-slide-content { font-size: 30px; padding: 1em 1em 1em 1em; } </style>